Skip to content

Conversation

@vmaerten
Copy link
Member

Summary

Fixes VitePress build errors caused by Vue template syntax (like {{.TASK_VERSION}}) in the changelog by automatically wrapping the content with v-pre directives during the release process.

Problem

When releasing, CHANGELOG.md is copied to website/src/docs/changelog.md. VitePress treats expressions like {{.TASK_VERSION}} as Vue interpolations, causing build failures. This required manual fixes after every release by wrapping these expressions with <span v-pre> tags.

Solution

Modified the release script to automatically inject VitePress v-pre directives:

  • Inserts ::: v-pre after the changelog title
  • Appends ::: at the end of the document

This prevents VitePress from processing Vue template syntax while keeping the changelog readable.

Changes

  • cmd/release/main.go: Added automatic v-pre wrapping logic (4 lines)
  • website/src/docs/changelog.md:
    • Added ::: v-pre wrapper around content
    • Removed 5 manual <span v-pre> tags (no longer needed)

@andreynering andreynering added the area: docs Changes related to documentation. label Nov 26, 2025
@vmaerten vmaerten merged commit 54ca217 into main Nov 29, 2025
13 checks passed
@vmaerten vmaerten deleted the fix/website-changelog branch November 29, 2025 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Changes related to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants